Resource URL: /platform/<<version=1>>/auth/providers/local/<ID>

    Overview: This resource applies the standard collection pattern to
              individual local providers.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the local provider.

       URL: GET /platform/<<version=1>>/auth/providers/local/<ID>

Query arguments:
scope=<enum> Where <enum> is one of user, default, effective.  If specified as
             "effective" or not specified, all fields are returned.  If
             specified as "user", only fields with non-default values are
             shown.  If specified as "default", the original values are
             returned.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "local": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the properties for a local authentication provider.", 
            "properties": {
              "max_password_age": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the maximum password age in seconds.", 
                "maximum": 4294967295
              }, 
              "min_password_age": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the minimum password age in seconds.", 
                "maximum": 4294967295
              }, 
              "login_shell": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the login shell path.", 
                "maxLength": 4096
              }, 
              "lockout_window": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked.", 
                "maximum": 2592000
              }, 
              "home_directory_template": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the path to the home directory template.", 
                "maxLength": 4096
              }, 
              "password_history_length": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the number of previous passwords to store.", 
                "maximum": 4294967295
              }, 
              "system": {
                "type": [
                  {
                    "type": "boolean", 
                    "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed."
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "lockout_threshold": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the number of failed login attempts necessary before an account is locked.", 
                "maximum": 50
              }, 
              "name": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the local provider name.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "password_prompt_time": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the time in seconds remaining before a user will be prompted for a password change.", 
                "maximum": 4294967295
              }, 
              "authentication": {
                "type": "boolean", 
                "description": "If true, enables authentication and identity management through the authentication provider."
              }, 
              "machine_name": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the domain for this provider through which users and groups are qualified.", 
                "maxLength": 255
              }, 
              "status": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the status of the provider.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "min_password_length": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the minimum password length.", 
                "maximum": 4294967295
              }, 
              "lockout_duration": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts.", 
                "maximum": 2592000
              }, 
              "password_complexity": {
                "minItems": 0, 
                "items": {
                  "enum": [
                    "lowercase", 
                    "uppercase", 
                    "numeric", 
                    "symbol"
                  ], 
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies the conditions required for a password.", 
                "maxItems": 4294967295
              }, 
              "id": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the local provider ID.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "create_home_directory": {
                "type": "boolean", 
                "description": "Automatically creates the home directory on the first login."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the local provider.

       URL: PUT /platform/<<version=1>>/auth/providers/local/<ID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the properties for a local authentication provider.", 
  "properties": {
    "min_password_age": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the minimum password age in seconds.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "min_password_length": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the minimum password length.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "login_shell": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the login shell path.", 
          "maxLength": 4096
        }
      ]
    }, 
    "lockout_window": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked.", 
          "maximum": 2592000
        }
      ]
    }, 
    "home_directory_template": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the path to the home directory template.", 
          "maxLength": 4096
        }
      ]
    }, 
    "password_history_length": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the number of previous passwords to store.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "lockout_threshold": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the number of failed login attempts necessary before an account is locked.", 
          "maximum": 50
        }
      ]
    }, 
    "name": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the local provider name.", 
      "maxLength": 255
    }, 
    "password_prompt_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the time in seconds remaining before a user will be prompted for a password change.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "authentication": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, enables authentication and identity management through the authentication provider."
        }
      ]
    }, 
    "machine_name": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the domain for this provider through which users and groups are qualified.", 
          "maxLength": 255
        }
      ]
    }, 
    "lockout_duration": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts.", 
          "maximum": 2592000
        }
      ]
    }, 
    "password_complexity": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "enum": [
              "lowercase", 
              "uppercase", 
              "numeric", 
              "symbol"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the conditions required for a password.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "max_password_age": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Specifies the maximum password age in seconds.", 
          "maximum": 4294967295
        }
      ]
    }, 
    "create_home_directory": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Automatically creates the home directory on the first login."
        }
      ]
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the local provider.

          URL: DELETE /platform/<<version=1>>/auth/providers/local/<ID>

There are no query arguments for this method.

There is no JSON response body for this method.
